Reporting API Endpoints

#1

Reporting endpoints allow you to pull information about your learners and results of your phishing and training campaigns into an outside system.

Applicable endpoints

Campaign specific information

The following endpoints allow you to pull the results about a specific AwareEd campaign run.

  1. List campaigns: /campaigns provides a full list of PhishSim and AwareEd campaigns. For this workflow, you will only need AwareEd campaigns.

  2. List campaign runs: /campaigns/{id}/runs provides a list of runs for a specific campaign. You will need the campaign ID and campaign run ID to retrieve the statistics.

  3. Retrieve statistics about a campaign run: /campaigns/{campaign_id}/runs/{run_id}/stats provides the details of how many learners have started their training, completed their training, passed or failed an assessment, and the total time trained for that campaign run. This endpoint can be used to see a high level view of your organization’s training completion.

  4. Retrieve statistics about learners in a campaign run: /campaigns/{campaign_id}/runs/{run_id}/learners provides a list of all learners enrolled in that campaign run, if they have not started, started, or completed training training, and if applicable, what date training was completed. This endpoint can be used for a more granular view of completion.

Timeline event information

Learner events in the IQ platform are captured at Timeline Events; such as a learner being enrolled in training, progress and completion events during training, phishing simulation interactions, and more. Using timeline event endpoints for data capture can be very useful. Since they log almost all activity in the platform, it’s recommended that you filter what you are pulling to smaller time frames (one week or less) and filter by specific event when possible.

  1. List timeline events: /timeline-events provides timeline events for all learners in your account. This endpoint can be filtered to specific events and time frames. One use case for this would be pulling enrollment and training completion events(“scheduled-in-aware-campaign-run” and “completed-aware-course”), to track learning progress. Another use case is pulling phishing to track how many times a learner fails a phishing test (“phished-learner”, “entered-data”, “opened-attachment”).
  2. List learner timeline events: /learners/{learner_id}/timeline-events provides timeline events per learner in your account and can only be filtered by timeframe. This endpoint can be particularly useful when gathering information about an exiting employee before removing them from the platform.

Additional Documentation

Click here for the complete Infosec IQ Open API documentation.

Infosec IQ API Support

The Infosec IQ Open API is provided with limited support. We can provide guidance about the functionality of our API endpoints but we are unable to assist with writing code or creating integrations with other software.